Create a new session. This is how you "log on" to the GCAPI.
| target | session |
| uriTemplate | /v2/Session |
| transport | POST |
| envelope | JSON |
| contentType | application/json |
| Name | Type | Description |
|---|---|---|
| apiLogOnRequest |
|
The request to create a session (log on). |
The following request to the Live GCAPI environment logs in to your account using the example credentials of Username as "DM123456" and password as "openthedoor".
The AppKey required to use the GCAPI is sent to you once you have returned the signed terms and conditions of the GCAPI to our Partnerships team:
(PartnershipServices[at]cityindex.com).
Post Request Query String
POST https://ciapi.cityindex.com/v2/Session
Post Request Body
{"Password":"openthedoor",
"AppVersion":"1",
"AppComments":"",
"UserName":"DM123456",
"AppKey":"ABC"
}
A successful request results in an HTTP 200 code in the response header, and the response body is the ApiLogOnResponseDTO v2 in JSON format.
Last updated: